XIQS Simplefilter

From IQsimWiki

Simple Filter Mechanism

For some of the "getXIQS … List", a filter mechanism can be applied to reduce the list of results orreorganize the output order (sort parameter).
This parameter object can be placed anywhere in the command and is always optional.
It takes the form of an XML structure with the following fields:

• "start" : in the whole possible results, starts output list at specified index
• "limit" : limit the output list to the specified number of objects
• "DIR" : when a sorting order is specified, defines the direction order. Only two values areaccepted => "ASC" : ascending order, "DESC" : descending order
• "SORT" : specifies the output list must respect the specified sorting order
• "query" : limit output by applying a filter on underlying requested results

Here is a demo sample of a simple filter applied on the GSM Operator List:

<?xml version="1.0" encoding="UTF-8"?>

<command name="getXIQSGsmOperatorList">

 <simplefilter>

  <start>11</start>

  <limit>20</limit>

  <DIR>ASC</DIR>

  <SORT>name</SORT>

  <query>countrycode &gt; 100</query>

 </simplefilter>

</command>

This sample command will return a list of GSM operator starting at the 11th position in result list, limited to 20 result objects, ordered on the GSM operator's name in the ascending order, and where the GSM operator's country code is greater than 100.
The accepted operators are the following:

operator	XML code	description
=		expressions are equal
<	&lt;	expression is lower than
>	&gt;	expression is greater than
<>	&lt;&gt;	expressions are different
~		expression contains (text values only)